Improve PR title guidelines in "Making good PRs" section#1773
Open
Shashank01177 wants to merge 1 commit intopython:mainfrom
Open
Improve PR title guidelines in "Making good PRs" section#1773Shashank01177 wants to merge 1 commit intopython:mainfrom
Shashank01177 wants to merge 1 commit intopython:mainfrom
Conversation
Added guidance for writing clear and descriptive pull request titles in the "Making good PRs" section. This helps avoid vague titles and improves clarity for contributors.
|
The following commit authors need to sign the Contributor License Agreement: |
Documentation build overview
Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
|
willingc
reviewed
Apr 16, 2026
Collaborator
willingc
left a comment
willingc
left a comment
There was a problem hiding this comment.
Thanks @Shashank01177. Please sign the CLA as mentioned in the automated checks.
| When creating a pull request for submission, there are several things that you | ||
| should do to help ensure that your pull request is accepted. | ||
|
|
||
| A pull request should have a clear and descriptive title that accurately reflects the change being made. Avoid vague titles such as "fix bug" or "update code". Instead, use specific titles like "Fix incorrect module suggestion for -S option" or "Improve error handling in importlib". |
Collaborator
There was a problem hiding this comment.
Suggested change
| A pull request should have a clear and descriptive title that accurately reflects the change being made. Avoid vague titles such as "fix bug" or "update code". Instead, use specific titles like "Fix incorrect module suggestion for -S option" or "Improve error handling in importlib". | |
| A pull request should have a clear and descriptive title that accurately reflects the change being made. | |
| Avoid vague titles such as "fix bug" or "update code". | |
| Instead, use specific titles like "Fix incorrect module suggestion for --output option" or "Improve error handling in importlib". |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added guidance for writing clear and descriptive pull request titles in the "Making good PRs" section. This helps avoid vague titles and improves clarity for contributors.